home *** CD-ROM | disk | FTP | other *** search
/ Netware Super Library / Netware Super Library.iso / admin / top20net / userlist / userlist.doc < prev    next >
Encoding:
Text File  |  1995-04-27  |  8.7 KB  |  214 lines
  1. User Information in various formats for The Major BBS                    V2.20
  2. Copyright (C) 1995 Danen Information Services.             All Rights Reserved.
  3.  
  4.  
  5.                         FOR "MAJOR BBS" SYSOPS ONLY!
  6.  
  7.  
  8. This program is produced as a pilot project to gauge interest in this sort of
  9. utility programs.  If you, as a SysOp, think that this is a valuable program,
  10. please leave me e-mail at one of the following addresses:
  11.  
  12.     InterNet  : gdanen@freenet.edmonton.ab.ca
  13.     CompuServe: 70672,1624
  14.     C+Net BBS : (403) 477-9545 (my home base)
  15.  
  16. Of course, if you find bugs or have suggestions, leave a message too!
  17.  
  18.  
  19. The purpose of the program will become obvious as soon as you run it, to
  20. produce information files in a variety of ways about the users of your BBS.
  21. I intend to expand on this program depending on input from SysOps like
  22. yourself.  If you have a need, let me know!  Right now, this program is
  23. offered as FreeWare.  That may change in the future.
  24.  
  25.  
  26. Back to Reality!
  27.  
  28. The way information is produced can be controlled with the userlist.ini file.
  29. Just like win.ini for Windows, you specify how the program is to behave.
  30. The default is the userlist.ini file in the same directory as the userlist.exe
  31. file.  If you change the name of userlist.exe to uli.exe, you must change the
  32. .ini file name to uli.ini.  Alternately, you may put the name of an .ini file
  33. on the command line.  This is useful if you want several different custom
  34. reports.  You can set up a batch file like this, for example:
  35.                 @echo off
  36.                 btrieve /p:2048 /e
  37.                 userlist
  38.                 userlist scenar-1.ini
  39.                 userlist scenar-2.ini
  40.                 userlist scenar-3.ini
  41.  
  42. You can have a [custom] section in the standard userlist.ini, and then have
  43. three different scenarios in the other .ini files.  The name of the .ini on the
  44. command line must be fully qualified if it's not in the current directory.
  45.  
  46.  
  47. The .ini file contains a number of sections, and control fields within each
  48. section.  The sections are:
  49.  
  50.         USERLIST  - General parameters for the program
  51.         REPORTS   - Which report files to produce and their names
  52.         BIRTHDATE - Parameters for the "Birthday Announcements" report
  53.         PURGE     - Parameters for the "Purge" report
  54.         ANSI      - ANSI colours for files that use them
  55.         CUSTOM    - Describes the "custom" report
  56.  
  57. Except for the custom report, the order of the information is not important.  A
  58. default .INI has been included.  Please have a look at it now.
  59.  
  60.  
  61. Date formats:
  62. Dates may be represented in a number of different ways:
  63.                 ddmmmyy     --> 01Apr95
  64.                 dd-mmm-yy   --> 01-Apr-95
  65.                 dd.mmm.yyyy --> 01.Apr.1995
  66.                 dd-mmm-yyyy --> 01-Apr-1995
  67.                 mm/dd/yy    --> 04/01/95
  68.                 yyyymmdd    --> 19950401
  69.  
  70. True/False (TF) fields:
  71. TF fields are logical fields where you indicate whether something is to happen
  72. or not.  By default, nothing happens.  If the first character after the = sign
  73. is a "Y" or "T" or "1" then we have a "true" condition.
  74.  
  75.  
  76. Sections in the .ini file:
  77.  
  78. [userlist]
  79. "passwords" is a TF field, and determines whether passwords are shown on the
  80. reports produced.
  81.  
  82. "creditinfo" is a TF field, and determines whether credit information is shown
  83. on the reports produced.  Some SysOps don't have a credit system, so why bother
  84. showing credit info...
  85.  
  86. "csvdate" is a date field and controls the date format for CSV files.  The
  87. default is yyyymmdd.
  88.  
  89. "repdate" is a date field and controls the date format for all reports, except
  90. the CSV file and the custom report.  The default is dd-mmm-yy.
  91.  
  92.  
  93. [reports]
  94. This is where you define which reports are to be produced, and what the file
  95. names are to be:
  96.                 standard=ul.std
  97.                 detail=ul.det
  98.                 csv=ul.csv
  99.                 birthdate=userinfo\bdates
  100.                 purge=sysop\2purge.lst
  101.                 stats=ul.sts
  102.                 custom=ul.cus
  103. You have three ways to suppress a report:
  104.                 1. remove its entry;
  105.                 2. leave the name blank (nothing after the = sign);
  106.                 3. put a semi-colon in front of the entry name, e.g.,
  107.                    ";detail=ul.det"
  108.  
  109.  
  110. [purge]
  111. Under this heading you describe the purge report. Personally, I have a lot of
  112. people checking out the BBS, and never call back if they're not interested in
  113. C/C++ programming or networking.  I want to cull those user entries to prevent
  114. a whole bunch of non-active users.  My rule is, if they don't call back within
  115. two weeks, they're out.  To do that, I compare the account creation date with
  116. the last login date.  If they're the same, and it's been over 14 days, they're
  117. shown on the report.  I also show the user's age, since I get a large number of
  118. teenagers calling who are just checking things out.
  119.  
  120. "days" determines how many days have to pass before the non-active users are
  121. shown on the report.
  122.  
  123.  
  124. [birthdate]
  125. Under this heading you describe the birthday listing.
  126.  
  127. "sort" is a TF field, and determines whether the report is to be sorted by
  128. birth date.
  129.  
  130. The "prev" and "next" parameters determine how may days to look back and into
  131. the future for inclusion in the list.  "prev" ranges from 0 to 10, and "next"
  132. from 1 to 60.
  133.  
  134. "format" only has one option, "ansi".  Under the [ansi] section, you get to
  135. pick your colours, otherwise red on white is used.  The rest of the parameters
  136. described under [birthdate] are only used IF you picked the ansi format...
  137.  
  138. If "cls" is true, the screen is cleared with the "bg" colour under [ansi].
  139.  
  140. Colour selections can be set for the name, the date, and the `happy birthday'
  141. note.  The entries are "fghappy", "bghappy", "fgdate", "bgdate", "fgname" and
  142. "bgname".  See under [ansi] for valid colour descriptions.
  143.  
  144.  
  145. [ansi]
  146. Two parameters in this section determine foreground "fg", and background "bg"
  147. colours on all reports that use ansi colours.  Acceptable colour descriptions
  148. are:
  149.                 Abbrev.     Meaning
  150.                 ----------  -------------
  151.                 C           Cyan
  152.                 M           Magenta
  153.                 R           Red
  154.                 W           White
  155.                 Y           Yellow
  156.                 BLA         Black
  157.                 BLU         Blue
  158.                 BRO         Brown
  159.                 BRW         Bright white
  160.                 BW          Ditto
  161.                 GRA         Gray
  162.                 GREY        Grey
  163.                 GREE        Green
  164.                 LB or LTB   Light blue
  165.                 LC or LTC   Light cyan
  166.                 LG or LTG   Light green
  167.                 LM or LTM   Light magenta
  168.                 LR or LTR   Light red
  169.                 LW or LTW   Bright white
  170. For example, "fg=lw" and "bg=re" produced bright white on red.  Note that once
  171. the "R" for red has been recognized, _anything_ may follow.  "rX" or "RedColor"
  172. will all result in RED.
  173.  
  174.  
  175. [custom]
  176. The custom report allows you to report on the fields that you need, and in the
  177. order (field order, not sort order!) you need them.  If you only want to see
  178. age and user name, or userid and age, here's your chance.  The order in which
  179. you show the parameters in this section determines the order on the report.
  180.  
  181. "name" is shown in one of four ways.  You may want to see both user id and real
  182. name, or just one or the other.  Take your pick!  "name=userid+realname" will
  183. show both the user id AND the real name IF the real name is different.  That
  184. same principle holds true for "name=realname+userid".  The other options are
  185. "name=realname" and "name=userid".
  186.  
  187. "namesize" determines how many characters of "name" to print.  If your users
  188. use short handles, you may want to see fewer than 30 characters (default), or
  189. if you're printing both real name and handle, you may wish to see more.  Can
  190. be 10 to 50.
  191.  
  192. "class" is a TF field, and determines whether to show the user's current class.
  193. By default the class is not shown.
  194.  
  195. "classize" determines how many characters of "class" to print.  Works like
  196. "namesize".  From 5 to 20.
  197.  
  198. Some date information you can show on the report:  "birth", "logindate" and
  199. "createdate" show date of birth, date of last login, and account creation date,
  200. respectively.  You can mix and match any of the allowed date formats.
  201.  
  202. Three numeric fields, related to the above described date fields, are "age",
  203. "logindays" and "createdays".  The number after the = sign indicated how many
  204. columns to use on the report.  "age" can use from 2 to 10 columns, while
  205. "logindays" and "createdays" can range from 3 to 10 columns.
  206.  
  207.  
  208. That's it!
  209.  
  210. Leave a message if something is not clear, please!
  211.  
  212.  
  213. Gerry Danen
  214.